<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<HTML>
  
  <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type">
    <TITLE>nwscode.pvtec.Pvtec -- A &lt;tt class="docutils literal">&lt;span class="pre">Primary&lt;/span> &lt;span class="pre">Valid&lt;/span> &lt;span class="pre">Time&lt;/span> &lt;span class="pre">Event&lt;/span> &lt;span class="pre">NwsCode&lt;/span>&lt;/tt> parser.</TITLE>
    <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet">
    
  </HEAD>
  <BODY>
    <DIV ID="page">
      
    <DIV ID="top-nav">
        <H1 ID="doc-title">
        <A HREF="index.html" REL="index">nwscode</A></H1>
        <DIV CLASS="online-navigation">
          <A HREF="index.html" REL="index">index</A>
          <SPAN ID="nav-docs">
            
          </SPAN>
          
          
          <BR>
          
          
          
          <A HREF="module-nwscode.html" TITLE="nwscode reference">
            nwscode
          </A>
          
            
            <A HREF="class-nwscode.pvtec.Pvtec.html">details</A>
            
            <A HREF="class-nwscode.pvtec.Pvtec-index.html">
              tree
            </A>
            
          
        </DIV>
    </DIV>
    
    <DIV ID="main-content">
  
  <H1 CLASS="pudge-member-page-heading">
    <TT>Pvtec</TT>
  </H1>
  <H4 CLASS="pudge-member-page-subheading">
    A <TT CLASS="docutils literal"><SPAN CLASS="pre">Primary</SPAN> <SPAN CLASS="pre">Valid</SPAN> <SPAN CLASS="pre">Time</SPAN> <SPAN CLASS="pre">Event</SPAN> <SPAN CLASS="pre">NwsCode</SPAN></TT> parser.
  </H4>
  <P CLASS="pudge-member-parent-link">
    <SMALL>
    The Pvtec class is accessible via the
    <A HREF="module-nwscode.pvtec.html">
      <TT>nwscode.pvtec</TT>
    </A> module.
    </SMALL>
  </P>
  <DIV ID="pudge-section-nav">
  <UL>
    <LI>
      <A HREF="#attributes" CLASS="pudge-section-link">
        Attributes (2)
      </A>
      
    </LI>
      
    <LI>
      <A HREF="#methods" CLASS="pudge-section-link">
        Methods (1)
      </A>
      
    </LI>
    
    <LI>
      <A HREF="nwscode/pvtec.py.html?f=32&amp;l=188#32" CLASS="pudge-section-link">
        Source
      </A>
    </LI>
  </UL>
  </DIV>
  <DIV STYLE="clear: left">
  </DIV>
  <DIV CLASS="rst pudge-module-doc">
    <P>For a full description of the P-VTEC format see the National Weather
Service's VTEC Directive:</P>
<BLOCKQUOTE>
<A HREF="http://www.nws.noaa.gov/directives/sym/pd01017003curr.pdf" CLASS="reference">http://www.nws.noaa.gov/directives/sym/pd01017003curr.pdf</A></BLOCKQUOTE>
<P>Attributes:</P>
<BLOCKQUOTE>
<DL CLASS="docutils">
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">fixedid</SPAN></TT></DT>
<DD>The Fixed Identifier. Identifies the following product and VTEC
code string types.</DD>
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">action</SPAN></TT></DT>
<DD>Identifies the action in the product issuance.</DD>
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">officeid</SPAN></TT></DT>
<DD>The standard four-letter identifier indicating the NWS office
with the primary responsibility for the affected area.</DD>
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">phenomena</SPAN></TT></DT>
<DD>Identifies the type of weather, flood, marine, fire weather,
etc., occurrence (e.g., freezing rain, river flood, gale, red
flag), or non-weather occurrence (e.g., ashfall).</DD>
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">significance</SPAN></TT></DT>
<DD>Identifies the level of importance (e.g., watch, warning,
advisory, etc.) of the weather or non-weather occurrence.</DD>
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">etn</SPAN></TT></DT>
<DD>The ETN is a four-digit number assigned to keep track of how an
event is addressed by various VTEC actions and/or products issued
over the lifetime of the event.</DD>
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">eventbegin</SPAN></TT></DT>
<DD>Start of the valid time span for the event.</DD>
<DT>
<TT CLASS="docutils literal">
<SPAN CLASS="pre">eventend</SPAN></TT></DT>
<DD>End of the valid time span for the event.</DD>
</DL>
</BLOCKQUOTE>
<P>Usage Example:</P>
<PRE CLASS="doctest-block">
>>> from nwscode.pvtec import PVTEC
>>> pvtec_string = '/X.EXT.PAFG.FG.Y.0002.000000T0000Z-060127T2100Z/'
>>> pv = PVTEC(pvtec_string)
>>> pv.action
'Extended in time'
>>> pv.significance
'Advisory'
>>>
</PRE>
  </DIV>
  
  <HR>
  
  
  
  
    <A NAME="attributes">
  
  
    </A>
    <H2>Attributes</H2>
    <DIV CLASS="pudge-member name">
    <A NAME="pattern">
    </A>
    <H4 CLASS="pudge-member-name">
    <SPAN CLASS="prefix">a</SPAN>
      <TT>
      <A HREF="class-nwscode.pvtec.Pvtec.html#pattern" CLASS="pudge-obj-link">pattern</A></TT></H4>
    <DIV CLASS="pudge-section rst">
      
      <PRE>&lt;_sre.SRE_Pattern object at 0x661560></PRE>
    </DIV>
  </DIV>
  <DIV CLASS="pudge-member name">
    <A NAME="interpreted">
    </A>
    <H4 CLASS="pudge-member-name">
    <SPAN CLASS="prefix">a</SPAN>
      <TT>
      <A HREF="class-nwscode.pvtec.Pvtec.html#interpreted" CLASS="pudge-obj-link">interpreted</A></TT></H4>
    <DIV CLASS="pudge-section rst">
      
      <PRE>{'action': {'CAN': 'Cancelled',
            'CON': 'Continued',
            'COR': 'Correction',
            'EXA': 'Extended in area',
            'EXP': 'Expired',
            'EXT': 'Extended in time',
            'NEW': 'New',
            'ROU': 'Routine',
            'UPG': 'Upgraded'},
 'fixedid': {'E': 'Experimental Product',
             'O': 'Operational Product',
             'T': 'Test Product',
             'X': 'Experimental VTEC in an Operational Product'},
 'phenomena': {'AF': 'Ashfall',
               'AS': 'Air Stagnation',
               'BS': 'Blowing Snow',
               'BW': 'Brisk Wind',
               'BZ': 'Blizzard',
               'CF': 'Coastal Flood',
               'DS': 'Dust Storm',
               'DU': 'Blowing Dust',
               'EC': 'Extreme Cold',
               'EH': 'Excessive Heat',
               'FA': 'Areal Flood',
               'FF': 'Flash Flood',
               'FG': 'Dense Fog',
               'FL': 'Flood',
               'FR': 'Frost',
               'FW': 'Fire Weather',
               'FZ': 'Freeze',
               'GL': 'Gale',
               'HF': 'Hurricane Force Wind',
               'HI': 'Inland Hurricane',
               'HS': 'Heavy Snow',
               'HT': 'Heat',
               'HU': 'Hurricane',
               'HW': 'High Wind',
               'HY': 'Hydrologic',
               'HZ': 'Hard Freeze',
               'IP': 'Sleet',
               'IS': 'Ice Storm',
               'LB': 'Lake Effect Snow and Blowing Snow',
               'LE': 'Lake Effect Snow',
               'LO': 'Low Water',
               'LS': 'Lakeshore Flood',
               'LW': 'Lake Wind',
               'MA': 'Marine',
               'RB': 'Small Craft for Rough Bar',
               'SB': 'Snow and Blowing Snow',
               'SC': 'Small Craft',
               'SE': 'Hazardous Seas',
               'SI': 'Small Craft for Winds',
               'SM': 'Dense Smoke',
               'SN': 'Snow',
               'SR': 'Storm',
               'SU': 'High Surf',
               'SV': 'Severe Thunderstorm',
               'SW': 'Small Craft for Hazardous Seas',
               'TI': 'Inland Tropical Storm',
               'TO': 'Tornado',
               'TR': 'Tropical Storm',
               'TS': 'Tsunami',
               'TY': 'Typhoon',
               'UP': 'Ice Accretion',
               'WC': 'Wind Chill',
               'WI': 'Wind',
               'WS': 'Winter Storm',
               'WW': 'Winter Weather',
               'ZF': 'Freezing Fog',
               'ZR': 'Freezing Rain'},
 'significance': {'A': 'Watch',
                  'F': 'Forecast',
                  'N': 'Synopsis',
                  'O': 'Outlook',
                  'S': 'Statement',
                  'W': 'Warning',
                  'Y': 'Advisory'}}</PRE>
    </DIV>
  </DIV>
    
  
    <A NAME="methods">
    
  
    </A>
    <H2>Methods</H2>
    <DIV CLASS="pudge-member routine alias">
    <A NAME="__init__">
    </A>
    <H4 CLASS="pudge-member-name">
    <SPAN CLASS="prefix">f</SPAN>
      <TT>
      <A HREF="class-nwscode.pvtec.Pvtec.html#__init__" CLASS="pudge-obj-link">__init__</A>(self, code_string='')</TT>
      <A HREF="nwscode/nwscode.py.html?f=25&amp;l=37#25" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    <P CLASS="pudge-member-blurb">
      Create an instance of the NwsCode class.
    </P>
    <P>The parameter 
    
    
    <CITE>code_string</CITE>
   should be a coded string.</P>
  
    </DIV>
  </DIV>
    
  
  
  <P>
    <SMALL>
    
    
    See 
    <A HREF="nwscode/pvtec.py.html?f=32&amp;l=188#32" TITLE="nwscode/pvtec.py:32">the source</A>
    for more information.
    </SMALL>
  </P>
</DIV>
    
    <DIV ID="footer">
      
      <P ID="pudge">
        Built with
        <A HREF="http://lesscode.org/projects/pudge/">
          Pudge/0.1.1</A>
      </P>
      
    </DIV>
    </DIV>
  </BODY>
</HTML>